Dev#11
Conversation
…rus Network, plus related images
…adjustments for improved readability
WalkthroughThe changes introduce a new "How-to Guides" section in the Astro sidebar configuration and add three new comprehensive how-to documentation pages: a general builder's guide, a participation guide, and a wallet setup guide. Additionally, existing agent client/server documentation is updated to use a new SDK package name in installation and import statements. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSite
participant Sidebar
participant Guides
User->>DocsSite: Visit documentation
DocsSite->>Sidebar: Render navigation
Sidebar-->>User: Show new "How-to Guides" section
User->>Guides: Select "Setup a Wallet" or builder guide
Guides-->>User: Display step-by-step instructions
Possibly related PRs
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
src/content/docs/how-to-guides/how-to-take-part.mdx (1)
1-92: Duplicate content detected - consolidate or differentiate.This file appears to contain identical content to
src/content/docs/how-to-guides/how-to-guides.mdx. Having duplicate content can cause confusion and maintenance issues.Consider one of these approaches:
- Remove duplicate: If both files serve the same purpose, keep only one
- Differentiate content: If they serve different purposes, modify the content to be distinct
- Create redirects: If both URLs need to work, create a redirect from one to the other
The current setup violates the DRY principle and could lead to content synchronization issues.
♻️ Duplicate comments (1)
src/content/docs/agents/client.mdx (1)
28-28: Verify the package name with double@@prefix.Same issue as in server-setup.mdx - the package name
@@torus-network/sdkuses an unusual double@@prefix that could cause installation failures.Also applies to: 34-34, 78-78, 304-304, 417-417
🧹 Nitpick comments (6)
astro.config.mjs (1)
102-111: Clean up commented-out duplicate code.The new "How-to Guides" section is properly structured, but the commented-out duplicate entry should be removed.
Apply this diff to clean up the commented code:
{ label: "How-to Guides", items: [ { label: "Setup a wallet", slug: "how-to-guides/setup-a-wallet" }, - // { - // label: "Setup a wallet", - // slug: "how-to-guides/setup-a-wallet", - // }, ], },src/content/docs/how-to-guides/setup-a-wallet.mdx (5)
52-54: Minor typo: “you browser” → “your browser”-1. **Open the SubWallet extension in you browser**: +1. **Open the SubWallet extension in your browser**:
84-86: Spelling: “successfull” → “successful”- Below is a reference image of a successfull account created in the + Below is a reference image of a successful account created in the
89-90: Image alt-text typoAlt text currently reads “…succesfully…”.
- +
97-101: Grammar & casing tweaks for the burger-menu instructionSmall readability fixes and consistent “SubWallet” casing.
-1. **Open the Subwallet Setup**: - Click in the three bars(**☰**) on the top left corner of the subwallet extension. +1. **Open the SubWallet menu**: + Click the three bars (**☰**) in the top-left corner of the SubWallet extension.
108-111: Typo: “mihgt” → “might”- You mihgt have to scroll down to find Torus in the list. + You might have to scroll down to find Torus in the list.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
public/images/how-to-guide/setup-wallet/subwallet-created-successfully.pngis excluded by!**/*.pngpublic/images/how-to-guide/setup-wallet/subwallet-done-torus-setup.pngis excluded by!**/*.pngpublic/images/how-to-guide/setup-wallet/subwallet-extension-activated.pngis excluded by!**/*.pngpublic/images/how-to-guide/setup-wallet/subwallet-open-setup.pngis excluded by!**/*.pngpublic/images/how-to-guide/setup-wallet/subwallet-search-torus-network.pngis excluded by!**/*.pngpublic/images/how-to-guide/setup-wallet/subwallet-select-config-to-add-network.pngis excluded by!**/*.png
📒 Files selected for processing (6)
astro.config.mjs(2 hunks)src/content/docs/agents/client.mdx(4 hunks)src/content/docs/agents/server-setup.mdx(2 hunks)src/content/docs/how-to-guides/how-to-guides.mdx(1 hunks)src/content/docs/how-to-guides/how-to-take-part.mdx(1 hunks)src/content/docs/how-to-guides/setup-a-wallet.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/how-to-guides/setup-a-wallet.mdx
[grammar] ~52-~52: Ensure spelling is correct
Context: ... 1. Open the SubWallet extension in you browser: Click on the SubWall...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~110-~110: Ensure spelling is correct
Context: ...your list of active networks. You mihgt have to scroll down to find Torus in th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (2)
astro.config.mjs (1)
40-50: LGTM - Clean reformatting.The reformatting of the "Capability Permissions" entry from single-line to multi-line format improves readability and consistency with other entries.
src/content/docs/how-to-guides/how-to-guides.mdx (1)
1-92: Well-structured guide with comprehensive coverage.The guide provides an excellent step-by-step walkthrough for builders wanting to participate in the Torus Network. The structure is logical and the content is well-organized.
|
|
||
| ```sh | ||
| npm install @torus-network/torus-ts-sdk | ||
| npm install @@torus-network/sdk |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify the package name with double @@ prefix.
The package name @@torus-network/sdk uses an unusual double @@ prefix, which is not standard for npm packages. Standard scoped packages use a single @ prefix (e.g., @torus-network/sdk). This could cause installation failures.
Please verify if this is the correct package name or if it should be @torus-network/sdk instead.
Also applies to: 37-37, 446-446
🏁 Script executed:
#!/bin/bash
# Check if the package exists on npm registry
npm view @@torus-network/sdk --json 2>/dev/null || echo "Package not found with @@"
npm view @torus-network/sdk --json 2>/dev/null || echo "Package not found with single @"Length of output: 4723
Correct npm package name prefix
The npm package @@torus-network/sdk is invalid (npm scoped packages use a single @). The correct package name on the registry is @torus-network/sdk. Please update all occurrences:
• src/content/docs/agents/server-setup.mdx: lines 31, 37, 446
Replace:
- npm install @@torus-network/sdk
+ npm install @torus-network/sdk🤖 Prompt for AI Agents
In src/content/docs/agents/server-setup.mdx at lines 31, 37, and 446, the npm
package name is incorrectly written as @@torus-network/sdk with a double '@'.
Replace all occurrences with the correct scoped package name @torus-network/sdk
using a single '@' to fix the invalid package reference.
|
|
||
| Every agent begins with a wallet that can sign transactions. | ||
|
|
||
| 👉 [How to create a wallet](/how-to-guides/set-up-wallet) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify that linked guides exist.
Many of the linked how-to guides appear to reference pages that don't exist yet. This could create a poor user experience with broken links.
Also applies to: 26-27, 35-36, 44-45, 53-54, 62-62, 70-71, 84-85
🏁 Script executed:
#!/bin/bash
# Check if the linked guide files exist
guides=(
"how-to-guides/set-up-wallet"
"how-to-guides/register-agent"
"how-to-guides/apply-to-be-whitelisted"
"how-to-guides/create-permission"
"how-to-guides/edit-permission"
"how-to-guides/create-capabilities"
"how-to-guides/delete-capabilities"
"how-to-guides/create-signal"
"how-to-guides/receive-emissions"
"how-to-guides/agent-api"
"how-to-guides/host-agent"
"how-to-guides/connect-to-chain"
"how-to-guides/respond-to-signal"
)
for guide in "${guides[@]}"; do
if [ -f "src/content/docs/$guide.mdx" ] || [ -f "src/content/docs/$guide.md" ]; then
echo "✓ $guide exists"
else
echo "✗ $guide not found"
fi
doneLength of output: 3711
Missing linked how-to guide pages
The following links in src/content/docs/how-to-guides/how-to-guides.mdx point to guides that don’t exist, which will result in broken links:
- /how-to-guides/set-up-wallet (line 18)
- /how-to-guides/register-agent (lines 26–27)
- /how-to-guides/apply-to-be-whitelisted (lines 35–36)
- /how-to-guides/create-permission (lines 44–45)
- /how-to-guides/edit-permission (lines 53–54)
- /how-to-guides/create-capabilities (line 62)
- /how-to-guides/delete-capabilities (lines 70–71)
- /how-to-guides/create-signal (lines 84–85)
- /how-to-guides/receive-emissions
- /how-to-guides/agent-api
- /how-to-guides/host-agent
- /how-to-guides/connect-to-chain
- /how-to-guides/respond-to-signal
Please add the corresponding .mdx (or .md) files under src/content/docs/how-to-guides/ for each of these topics, or update/remove the links to point at existing pages.
🤖 Prompt for AI Agents
In src/content/docs/how-to-guides/how-to-guides.mdx around lines 18 to 85,
several links point to how-to guide pages that do not exist, causing broken
links. To fix this, create the missing .mdx or .md files for each linked topic
under src/content/docs/how-to-guides/, or alternatively update or remove the
links to point to existing valid pages to ensure all links are functional.
|
|
||
| 1. **Download the Extension** | ||
| Visit the [SubWallet download page](https://www.subwallet.app/download.html) and download the appropriate version of the extension for your browser (Chrome, Brave, Firefox, or Microsoft Edge). | ||
|
|
||
| 3. **Activate/Pin the Extension** | ||
| In some cases, you may need to activate the extension manually. Refer to the [SubWallet documentation](https://docs.subwallet.app/main) for instructions. |
There was a problem hiding this comment.
Step numbering skips “2.” – update for clarity
Readers will wonder whether an instruction is missing because the list jumps from “1.” to “3.”. Renumber or convert to automatic Markdown numbering.
-3. **Activate/Pin the Extension**
+2. **Activate/Pin the Extension** 📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. **Download the Extension** | |
| Visit the [SubWallet download page](https://www.subwallet.app/download.html) and download the appropriate version of the extension for your browser (Chrome, Brave, Firefox, or Microsoft Edge). | |
| 3. **Activate/Pin the Extension** | |
| In some cases, you may need to activate the extension manually. Refer to the [SubWallet documentation](https://docs.subwallet.app/main) for instructions. | |
| 1. **Download the Extension** | |
| Visit the [SubWallet download page](https://www.subwallet.app/download.html) and download the appropriate version of the extension for your browser (Chrome, Brave, Firefox, or Microsoft Edge). | |
| 2. **Activate/Pin the Extension** | |
| In some cases, you may need to activate the extension manually. Refer to the [SubWallet documentation](https://docs.subwallet.app/main) for instructions. |
🤖 Prompt for AI Agents
In src/content/docs/how-to-guides/setup-a-wallet.mdx around lines 28 to 33, the
numbered list skips from step 1 to step 3, which can confuse readers. Fix this
by either renumbering the steps sequentially or by using automatic Markdown
numbering (e.g., using "1." for all steps) so the list renders with correct
numbering.
2 participants
Summary by CodeRabbit
New Features
Documentation